/*
 *  ClientDispatchLog.h
 *  ClientDispatch
 *
 *  Created by Andrey on 04/11/2008.
 *  Copyright 2008 ИУ7-2003. All rights reserved.
 *
 */

/**	\file ClientDispatchLog.h
	\brief Файл содержит описания функций, предназначенных для работы с журналом
	библиотеки ClientDispatch.
 */

#ifndef CLIENT_DISPATCH_LOG
#define CLIENT_DISPATCH_LOG

/** \def MAX_LOG_MESSAGE_LENGTH
	Константа, определяющая максимальную длину сообщения в журнале.
 */
#define MAX_LOG_MESSAGE_LENGTH 256

/** \fn int InitClientDispatchLog(const char* logFilename);
	\brief Функция, инициализирующая журнал библиотеки ClientDispatch
	\param const char* logFilename -- имя файла, в котором будет храниться журнал.
	\return 0 в случае успешного создания журнала, <0 -- в противном случае
 */
int InitClientDispatchLog(const char* logFilename);
/** \fn void Log(const char* format, ...);
	\brief Функция, осуществляющая запись в журнал библиотеки ClientDispatch
	\param const char* format -- строка формата, содержащая сообщение и 
	escape-последовательности (аналогично функции printf())
	\return Ничего
 */
void Log(const char* format, ...);
/**	\fn void ShutdownClientDispatchLog();
	\brief Функция, завершающая работу журнала библиотеки ClientDispatch.
	\param Нет
	\return Ничего
	\warning После вызова этой функции сообщения гарантированно окажутся 
	записанными в файл журнала. До вызова этой функции такой гарантии библиотека
	СlientDispatch предоставить не может.
 */
void ShutdownClientDispatchLog();

#endif